M

FlexPipe.Create

Description:
Creates a new flexible pipe into the document, using a point array and flex pipe type.

Overloads (2):

Create

Create(Document,ElementId,ElementId,ElementId,IList[XYZ])

Create(Document,ElementId,ElementId,ElementId,XYZ,XYZ,IList[XYZ])

public static FlexPipe Create(
	Document document,
	ElementId systemTypeId,
	ElementId pipeTypeId,
	ElementId levelId,
	XYZ startTangent,
	XYZ endTangent,
	IList<XYZ> points
)

Public Shared Function Create ( 
	document As Document,
	systemTypeId As ElementId,
	pipeTypeId As ElementId,
	levelId As ElementId,
	startTangent As XYZ,
	endTangent As XYZ,
	points As IList(Of XYZ)
) As FlexPipe

public:
static FlexPipe^ Create(
	Document^ document, 
	ElementId^ systemTypeId, 
	ElementId^ pipeTypeId, 
	ElementId^ levelId, 
	XYZ^ startTangent, 
	XYZ^ endTangent, 
	IList<XYZ^>^ points
)

static member Create : 
        document : Document * 
        systemTypeId : ElementId * 
        pipeTypeId : ElementId * 
        levelId : ElementId * 
        startTangent : XYZ * 
        endTangent : XYZ * 
        points : IList<XYZ> -> FlexPipe

Document

document

The document.
ElementId

systemTypeId

The id of the piping system type.
ElementId

pipeTypeId

The id of the flexible pipe.
ElementId

levelId

The level id for the flexible pipe.
XYZ

startTangent

The tangent vector at the start of the curve. The invalid or zero vector is ignored.
XYZ

endTangent

The tangent vector at the end of the curve. The invalid or zero vector is ignored.
IList<XYZ>

points

The point array indicating the path of the flexible pipe, including the end point.

Return Value FlexPipe If creation was successful then a new flexible pipe is returned, otherwise an exception with failure information will be thrown.

ArgumentException

The systemTypeId is not valid piping system type. -or- The type pipeTypeId is not valid flexible pipe type. -or- The ElementId levelId is not a Level. -or- The valid number of points is less than two. In order to create a flex curve, at least two points are required. Note the duplicate points don't take into account.
ArgumentNullException

A non-optional argument was null